home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
doors_2
/
tv260.zip
/
TVAULT.DOC
< prev
next >
Wrap
Text File
|
1991-08-28
|
20KB
|
661 lines
----------------------
T i m e V a u l t
----------------------
a time banking door for
Searchlight BBS 2.x
version 2.6
Copyright (c) 1989-91
CCS Systems & Jim Barry
Table of Contents
-----------------
Introduction .................................................. 2
Registration Information ...................................... 2
Setup & Installation .......................................... 3
Advanced Options/Extra Features ............................... 4
Deposit .................................................. 4
Withdraw ................................................. 4
TVAULT.CFG ............................................... 5
Transfer ................................................. 6
Goodbye .................................................. 6
Sysop Utilities .......................................... 6
2-Sysop .................................................. 7
Status Line .............................................. 7
Sample Command Lines .......................................... 7
TVAULT.LOG Activity Log File .................................. 8
Sysop Chat Mode ............................................... 8
Acknowledgments ............................................... 9
Disclaimer .................................................... 9
- 1 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
------------
Introduction
------------
Time Vault is a professional quality, utility/game door written for
Searchlight bulletin board software, Version 2.x and up. The original
version was released in 1989 and has been constantly gone through
revisions and upgrades. The current version is loaded with many features
and we feel this is the best utility door available for SLBBS.
Here is a listing of major features offered by Time Vault:
1. Allows users to store system time and withdraw at a later time.
2. Blends into Searchlight by utilitizing the same look and feel.
3. Color choices come from your SL configuration.
4. Transfer feature to give time to a different user. (option)
5. Local status line with ALT/F-key support. (option)
6. Goodbye feature to allow BBS logoff via door. (option)
7. Configure maximum balances/withdrawals via access levels using a
text file. (option)
8. Scans EVENT.DEF file to ensure Time Vault withdrawals do not
interfere with an upcoming event.
9. Sysop chat mode just like Searchlight.
10. Sysop Utility feature allowing Sysops to modify user account
balances and print listings of the vault file.
11. Activity log of all Time Vault transactions.
------------
Registration
------------
Time Vault is distributed as 'shareware' and continued use after an
acceptable trial period requires a registration fee. The trial period is
21 days (3 weeks), after which, a registration fee of $15 (US funds) must
be paid to the author. If you fail to register after the 21 day trial
period, you MUST discontinue use of the software. The only way shareware
authors get compensated for their efforts is through registrations.
Please support the shareware marketing concept and encourage authors to
produce updates, as well as new shareware programs.
- 2 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
------------------
Setup/Installation
------------------
The following files should be contained in this ZIP archive:
TVAULT .DOC - Time Vault documentation file
TVAULT .EXE - The actual Time Vault program file
TVUPDATE.TXT - Update information on Time Vault
TV-ORDER.FRM - Order form for registering
(If any of these files are missing, please ask the sysop of the BBS
from which you obtained it to remove the archive from his system.)
Because Time Vault is designed specifically for Searchlight, it is one
of the easiest programs to setup. Please follow these easy steps:
Place the TVAULT.EXE file somewhere on your harddrive. We suggest
your main BBS directory. The same directory that you keep BBS.EXE,
FILE.EXE, etc, in.
Next, make an entry into your DOORS.DEF file. Follow the format of
the one below.
2;0;1;30;Time Vault - Store Time;.;C:\BBS\TVAULT.EXE
| | | | | | |
a b c d e f g
a) Tells Searchlight to provide communications support. Set this to
a (2), telling Searchlight to send color to the remote user even
if the local BBS computer is monochrome.
b) Disk-drive write protection during door. This must be set to a
(0) to allow Time Vault to write it's information.
c) Action on carrier loss. Set this to a (1), telling Searchlight
to terminate the door program if the carrier is dropped during
door execution.
d) BBS access level required to use door.
e) Description of door displayed to your users.
f) Directory to switch to before executing door. This should ALWAYS
be set to a PERIOD ONLY as it is above. Time Vault looks in the
current directory only when trying to read the CONFIG.SL2 file.
Making this a PERIOD will ensure that the correct CONFIG.SL2 file
is always found.
g) The full path and file to the TVAULT.EXE file.
If you have additional DOOR.DEF files for other nodes, make identical
entries in those also.
- 3 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
That's it. You've installed Time Vault, with the basic, default
setup. Not too tough, eh? <grin> The basic installation allows:
- maximum account balance of 60 minutes.
- maximum daily balance of 30 minutes.
- "Deposit", "Withdraw" and "Quit" menu options.
To customize this installation, as well as activating extra options,
please see the next section.
-------------------------------
Advanced Options/Extra Features
-------------------------------
Time Vault, without any additional command line switches, will operate
just fine. However, there are several options that can be enabled. The
format for running Time Vault with these options is:
TVAULT.EXE -[option-1] ... -[option-n]
** DEPOSIT **
The deposit command allows your users to store a maximum of anywhere
between 0 and 32767 minutes in their 'account.' By default, the maximum
balance is set to 60 minutes.
To allow users to store MORE time, you can run Time Vault with the
'-MB=' paramemter. To allow users to store 500 minutes of time, you
would run Time Vault with this command line:
TVAULT.EXE -MB=500
This would now allow account balances of 500 minutes. See the section
on the TVAULT.CFG file for another configuration option of maximum
balances.
** WITHDRAW **
The withdraw command allows your users to take time out of their
account. By default, the user can remove 30 minutes/day. The range of
daily withdrawal values is 0-1440. A maximum withdrawal of 0 disables
the daily withdrawal limit.
To allow users to withdraw more than 30 minutes/day, you can use the
'-MW=' command line switch. To allow users to withdraw up to 200
minutes/day, run Time Vault with this command line:
TVAULT.EXE -MW=200
This would now allow daily withdrawals of 200 minutes. See the
section on the TVAULT.CFG file for another configuration method of
maximum withdraws.
- 4 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
** TVAULT.CFG File **
The TVAULT.CFG file give the sysop the ability of assigning maximum
balance and maximum daily withdrawal limits based on the users access
level. By doing this, you may give higher level users the ability to
store or withdraw more time than lower level users.
When Time Vault is trying to determine what the settings of maximum
balances and maximum daily withdrawals is, it performs the following
steps:
- Looks in the current nodes CONFIG.SL2 directory for TVAULT.CFG
- Looks in the main data directory for TVAULT.CFG
- Looks at the TVAULT.EXE command line for switches
- Uses internal defaults
On a single node system, place the TVAULT.CFG file into your main data
directory.
If you operate a multinode system, the TVAULT.CFG file can reside in 1
of 2 places. You can place it into your CONFIG.SL2 directory. If you
put it here, the TVAULT.CFG file becomes specific to that node only. Or,
you can place it into your main data directory, making that configuration
file global to all nodes.
The format of the TVAULT.CFG file very simple. You can create the
file using any text editor program. Even use Searchlight's built in
editor if you like. The file should be laid out as follows:
{access level} = {maximum balance};{maximum daily withdrawal}
This file may contain as many lines as necessary. When Time Vault
reads this file, it attempts to match an access level that is less than
or equal to the current user's access level.
Here is a sample TVAULT.CFG file:
10 = 30;15
50 = 60;60
100 = 120;0
Now, if a user runs Time Vault, this is what his maximum withdrawals
and maximum balance settings will be set to:
User Access Maximum Balance Maximum Withdrawal
10 30 minutes 15 minutes
50 60 " 60 "
20 30 " 15 "
5 0 " (no limit)
150 120 " (no limit)
- 5 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
** TRANSFER **
The transfer option allows users to trade time with other users. It's
a very simple feature to operate. By default, this option is not
available to you users, however, it can be enabled using the '-T' command
line switch like this:
TVAULT.EXE -T
A user can only transfer time that is IN their account. The maximum a
user can transfer is equal to their account balance. The amount they can
transfer to a specific user is determined by that users current balance
and the user doing the transferings maximum balance limit.
For example, if Suzie Snowflake attempts to transfer time to user Joe
Blow and Suzie has 60 minutes in her account. Joe has 15 minutes in his
account. Suzie's maximum balance is 60 minutes. Suzie's maximum balance
limit gets applied to Joe's account. So, a maximum balance of 60 minutes
minus Joe's current balance of 15 leaves 45. Suzie can transfer a
maximum of 45 minutes to Joe Blow.
It is a simple, straightforward function. You might want to try it
out yourself before deciding to let your users use it.
** GOODBYE **
The optional Goodbye command does just that. Logs the user off your
BBS directly from the door program. This command can be activated by
running Time Vault with the "-G" command as follows:
TVAULT.EXE -G
When a user selects this function, they are given an "Are you sure?"
question to confirm they wish to logoff. If they choose Yes, the door
will terminate and look like it is returning to the BBS as normal.
HOWEVER when the BBS reloads, it thinks it just ran the auto-LOGOFF door,
and will immediately display your LOGOFF.TXT/ANS file and hangup.
The only drawback of this command is that, when used, you auto-logoff
door does not get run.
** SYSOP UTILITY **
Time Vault has a Sysop Utility mode built into the program. Getting
to this special utility menu can be done by one of three methods:
1) Run the door as a user with 254 or 255 access.
2) Toggle the superuser flag and run the door.
3) Run Time Vault with the '-S' command line switch.
The Utility menu has 3 options; "Edit", "List", and "Quit".
The Edit command prompts you for a username (or partial user name) to
select. Once a user is selected, the balance of their account can be
edited. As the sysop, you can set the balance anywhere from 0 to the
maximum of 32767. You are not limited to the settings on the command
line or in the TVAULT.CFG file.
- 6 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
The LIST command allows you to display account information of your
users in a table format. The information is displayed as "Balance",
"User Name", and "Last Transaction". The listing can be aborted by
hitting the spacebar or control-C at anytime.
AVAILABLE in the Registered Version of Time Vault-- You can choose to
output the information to either the screen, or to a file or DOS device.
If you choose "File/Print", you will be prompted to enter the output
filename. To send the list to a disk file enter a filename. If you want
the list sent to a printer or other DOS device, enter as "LPT1", "PRN",
etc. The unregistered version only allows printing to the screen.
** 2-SYSOP **
I lied. There is a 4th way to execute the Sysop Utility menu. If a
user is currently running Time Vault and you want to get to the Sysop
Menu, turn on the superuser flag (ALT-S). The NEXT time the Time Vault
menu is displayed, the "2-Sysop" command will appear. Choosing this
option will take you to the Time Vault Sysop Utility menu.
** LOCAL STATUS LINE **
Time Vault can display a local status line that looks identical to the
Searchlight status line. By default, the status line is not enabled. To
activate it, use the '-L' command line switch like this:
TVAULT.EXE -L
When activated, you can use the following hot-keys on the local
computer:
ALT-A - toggles the sysop availability flag
ALT-S - toggles the super user access flag
ALT-N - toggles the sysop next flag
F8 - Toggles user information in the status line
F9 - Increases users current session time limit in 5
minute intervals
F10 - Decreases users current session time limit in 5
minute intervals
--------------------
Sample Command Lines
--------------------
TVAULT.EXE -MB=1000 -G
Executes Time Vault with Deposit, Withdrawal, Goodbye and Quit options
active. The maximum balance is set to 1000 minutes. The maximum
withdrawal is set to 30 minutes (the default).
TVAULT.EXE
Executes Time Vault with the Deposit, Withdraw, and Quit options
active. Maximum balance is set to 60 minutes, Maximum withdrawal set to
30. (both defaults)
- 7 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
TVAULT.EXE -T -G -MB=500 -MW=100 -L
Executes Time Vault with Deposit, Withdraw, Transfer, Goodbye, and
quit options active. Maximum balance is set to 500 minutes. Maximum
withdrawal is set to 100 minutes/day. The local status line is also
activated.
TVAULT.EXE -S -L
Executes Time Vault in Sysop Utility mode. Local status line is also
activated.
-----------------
Activity Log File
-----------------
Time Vault automatically generates an activity log file when run. The
activity log is placed into the main BBS directory. There is only 1 log
file for all nodes in a multi-user setup. The entries are in the
following format:
{date} {time} {username} {action} {number of minutes}
For example:
08/28/91 09:42 SUZIE SNOWFLAKE withdrew 20 minutes
All Deposits, Withdrawals, and Transfers are logged.
---------------
Sysop Chat Mode
---------------
At anytime during program execution, the sysop can enter chat mode
with the user by pressing <ALT-C> on the local computer keyboard. This
chat mode operates and feels just like the Searchlight chat mode. In
fact, your users won't even think about the fact that they are in a door
program.
Hitting the <Escape> key on the local keyboard will exit chat mode.
Program execution will resume at the exact point at which you interrupted
it.
- 8 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry
---------------
Acknowledgments
---------------
- Frank LaRosa, author of Searchlight BBS.
- Gregg Flagg, motivated me to write a time bank door for Searchlight,
as well as coming up with the name "Time Vault".
- Chris Costakis, for just being an annoying pest to get me to write a
version of Time Vault for the Shareware Searchlight. And THEN he
switches to the extended version a week later.
- Borland International, for providing the world with Turbo Pascal,
which Time Vault is written in.
----------
Disclaimer
----------
We hereby state that when we released this program, it had been tested
to the best of my abilities. We will not be held liable for incidental
or consequential damages as the result of the use of this software. We
give no warrantees or guarantees of anykind.
We further state that there are no undocumented features in this
software.
Your use of the software confirms your acceptance to the disclaimer
information.
--------
Footnote
--------
Comments, Suggestions, and Registrations may be mailed to:
C.C.S. Systems
Attn: Jim Barry
PO Box 35487
Cleveland, OH 44135-0487
And if your really in the mood to get in touch with me, (or at least
the latest release of Time Vault), you can call my BBS:
Time Vault BBS (pcp: OHCLE) (Starlink: 4222, 10077)
(216) 951-9150, 8-N-1, 3/12/2400 Baud
And remember: When a program has no bugs... It's obsolete!
- 9 -
Time Vault v2.6, (c) Copyright 1989-91, CCS Systems & Jim Barry